home *** CD-ROM | disk | FTP | other *** search
/ FishMarket 1.0 / FishMarket v1.0.iso / fishies / 526-550 / disk_527 / picbase / picbase.doc < prev    next >
Text File  |  1992-05-06  |  22KB  |  494 lines

  1. PicBase - An IFF Picture Data Base Program
  2. v0.36 - 5 Jul 1991 - Freely Distributable, but All Rights Reserved
  3. ShareWare:
  4.     Mike Berro
  5.     P.O. Box 923113
  6.     Sylmar, CA  91392-3113
  7.  
  8.  
  9. Pre-Introduction
  10.  
  11.     PicBase came about because I had wanted to do a non-linear editing
  12. system on the Amiga.  I could not get funding for the project, so I
  13. developed it into what you have here.  I tried getting a publisher
  14. interested in it, to no avail.  So here it is; incomplete, but what it
  15. does I think it does well.
  16.     If there is interest (i.e. shareware dollars), I will add support
  17. for non-native graphics modes (IFF24, DCTV(tm), HAM-E(tm), etc.),
  18. support for ARexx(tm), and whatever else comes along.  Feel free to
  19. suggest improvements when you send your money.
  20.     My personal feeling is that if Amiga users don't stop passing
  21. around commercial software instead of buying it, they will have to shop
  22. for another computer rather soon.
  23.  
  24.  
  25. Introduction
  26.  
  27.     PicBase requires WB2.0 or the ARP library.
  28.  
  29.     PicBase is a program that allows the user to organize and manage
  30. all IFF images and brushes stored on disk.  The program displays a
  31. miniature monochrome (8 or 16 level) image of each file, with
  32. information such as the full pathname, the creation date, file size,
  33. image size and depth, display mode (LACE, HAM, etc.), and filenote
  34. (comment).
  35.  
  36.     The images are displayed four at a time, and can be scrolled in
  37. real-time.  Images can be manually or automatically sorted.  You can
  38. search to a particular image using keywords.  The image files can be
  39. renamed, moved, copied or deleted from disk, either individually or in
  40. groups using the multiple-select clipboard.  Double-clicking an image
  41. will display it.
  42.  
  43.     A special "multi-view" window allows you to view up to 108 images
  44. at once.
  45.  
  46.     The images can also be presented as a slideshow, moving
  47. automatically or manually forward and reverse.  The images can also be
  48. played back in reduced size monochrome form as an animation preview, at
  49. up to 30 frames per second.
  50.  
  51.     A list of images can be printed, or saved as a text file.  A
  52. script file can also be created.
  53.  
  54.     Help mode gives on-line information about every gadget.  
  55.  
  56.  
  57. Features
  58.  
  59. *Two modes: full-screen display of 108 "sub-miniature" images, and
  60. a "story-board" display of 4 miniature images.
  61.  
  62. *Stores and displays full pathname, file size, creation date,
  63. filenote, image specifications and time code for each image.
  64.  
  65. *Scans directories and disks automatically.  Update data
  66. automatically.
  67.  
  68. *Extremely fast image shrink and color remap on all Amiga graphic
  69. modes, including HAM and Halfbright.
  70.  
  71. *Cut, copy and paste IFF data.
  72.  
  73. *Copy, Move, Rename and Delete individual or groups of image files.
  74.  
  75. *Sort the images by pathname, filename, creation date, file size
  76. and time code.
  77.  
  78. *Search for any image.
  79.  
  80. *Automatic double-buffered slide show.
  81.  
  82. *Animation preview of miniature images.
  83.  
  84. *Export image data list to printer or file.  Export a script file
  85. based on image data order.
  86.  
  87. *Uses DOS 2.0 if available, otherwise requires the ARP library.
  88.  
  89. *Full prompting on any command that might lose data.
  90.  
  91. *On-line help: In Help Mode you can click on any gadget and get a
  92. full description of what it does.
  93.  
  94. *File requester keeps track of last used Load path, Save path &
  95. file, Copy/Move path and file, and Print path and file.  Load path
  96. & filename are transferred to Save path & filename only if
  97. compiled data is loaded.  Full paths are always displayed, even if
  98. user enters assigned name or relative path.
  99.  
  100. *Creates data file icons.
  101.  
  102.  
  103. Version History
  104.  
  105. v0.28    Added halfbright support.
  106. v0.29    Added the PLAY function.
  107.     Fixed crash bug after search request.
  108. v0.30    Added the SHOWIMAGE window gadget.
  109.     The sorting speed has been increased dramatically.
  110.     Left mouse button aborts most things.
  111. v0.31    Added the shrink gadget ("Iconify").
  112.     Added the "clipboard of images".
  113. v0.32    Added HELP mode.
  114. v0.33    Added the Multi-View window.
  115. v0.34    Fixed bug when loading images (brushes) smaller than shrink.
  116. v0.35    Miscellaneous minor improvements.
  117. v0.36    Added multipage gadgets to Multi-View.
  118.  
  119.  
  120. Current Bugs
  121.  
  122.     Dynamic hires, dynamic HAM, SHAM, HAM-E and DCTV images are loaded
  123. and catalogued, but are not displayed properly.  IFF24 images have not
  124. been tested, may crash.  "Stencil" images (whatever they are) may also
  125. cause PicBase to crash.
  126.  
  127.     Cut, Copy & Paste do not update the display properly when there
  128. are less than four compiled images.  Click on the scroll bar to update
  129. the display.
  130.  
  131.     When using WB 1.3, brushes smaller than standard screen size can
  132. cause a problem.  When displaying a brush, a mouse click to the right
  133. of the screen will have no effect.  Move the mouse pointer to the
  134. upper-left and click.  Under 2.0, the mouse is constrained to stay
  135. within the screen, so there is no problem.
  136.     Because of this problem, brushes smaller than standard image size
  137. are not displayed centered.
  138.  
  139.  
  140. Future Additions and Notes
  141.  
  142.     Load and remap ANIM, IFF24, HAM-E and DCTV images.
  143.  
  144.     Write the filenote when moving or copying a file.
  145.  
  146.     Search & Replace.
  147.  
  148. Preferences: Ignore brushes, wildcard selection criteria, no
  149. viewing of images during scanning.
  150.  
  151. Data compression on compiled data.  The compiled bitmaps are
  152. currently stored raw, which yields about 170 images in 860K. 
  153. Compression should help immensely.
  154.  
  155. Note: HAM images are shrunk first, then remapped.  This speeds the
  156. process considerably, but results in streaking in some HAM images. 
  157. Perhaps slow/fast should be user-selectable.
  158.  
  159.  
  160. Quick Instructions
  161.  
  162. 1    Running PicBase
  163.  
  164.     PicBase can be run from the CLI, Shell or Workbench.
  165.  
  166.     There are several methods of running PicBase from the Workbench. 
  167. Double-clicking the PicBase icon will cause it to appear with an empty
  168. list.  Double-clicking on a PicBase data file icon will cause PicBase
  169. to load the data from that file.  If you first click on a drawer, and
  170. then double-click on the PicBase icon while holding down the SHIFT key
  171. (this is called "extended selection"), PicBase will load and compile
  172. each image in the drawer.  If you first click on a IFF image file icon,
  173. and then double-click on the PicBase icon while holding down the SHIFT
  174. key, PicBase will load and compile that one image.
  175.  
  176.     When running PicBase from the CLI or Shell, you can add the data
  177. file name, a directory name, or an IFF image file name, and PicBase
  178. will load the appropriate file(s).
  179.  
  180. 2    The PicBase Screen
  181.  
  182.     At the top of the screen are displayed four images from the list
  183. of compiled data.  Each image has the cel number (0001-9999) in the
  184. upper-left, and the associated time code (see below) in the upper-
  185. right.  Below each cel is the filename (not the full pathname, due to
  186. space limitations).
  187.  
  188.     If there are more than four compiled images, you may scroll
  189. through the list using the scroll gadget below the images, clicking on
  190. the arrow gadgets, or by pressing the left and right arrow keys on the
  191. keyboard.  The left and right arrow gadgets can be clicked once to
  192. scroll one image, or held down to continuously scroll.  If you hold
  193. down either shift key and click an arrow gadget, the list scrolls to
  194. the beginning or end immediately.
  195.  
  196.     Below the four images is the data display for the "current image",
  197. which includes a copy of the compiled image itself.  A new current
  198. image is chosen by clicking on one of the four displayed images
  199. (double-clicking displays the actual image, see below).  Note that the
  200. current image does not have to be one of the four images displayed in
  201. the list.  This is important, because some commands described below
  202. only operate on the current image.
  203.  
  204.     Below and to the right of the current image data is a blank area
  205. for an extra image.  This area displays the "image buffer", which is
  206. used for the commands CUT, COPY, and PASTE (see below).  In the center
  207. of the screen are the command gadgets.
  208.  
  209.     Useful information about the compiled data is displayed near the
  210. bottom of the screen.  This includes the number of cels in the list,
  211. followed by the number of additional cels you can load, given how much
  212. free memory is available.  This number is approximate (and under-
  213. estimated), because the amount of memory used by each cel depends on
  214. the length of the filename and comments.  Also shown is the date ("Data
  215. Date") of the last loaded or saved compiled data file, and the total
  216. memory used by all the original IFF files in the list.  Note that the
  217. Data Date will revert to dashes if there is no "current" compiled data
  218. file (as indicated in the window title), which happens after loading
  219. individual IFF images.
  220.  
  221.     At the top of the screen are two "title bars".  The upper one
  222. belongs to the "screen".  You can click and hold down the left mouse
  223. button with the pointer over the screen title bar and drag the screen
  224. up or down.  You can also click on the screen's front/back gadget(s)
  225. [two for Workbench 1.3, one for 2.0].
  226.  
  227.     The window title bar contains the standard CLOSEWINDOW gadget in
  228. the upper-left, and in the upper-right four miscellaneous window
  229. gadgets.  From left to right, these window gadgets are HELP,
  230. WINDOWSHRINK, MULTIVIEW, UP-DOWN and SHOWIMAGE.  The HELP gadget puts
  231. PicBase into the Help Mode.  The WINDOWSHRINK gadget reduces PicBase to
  232. a tiny window on the Workbench screen.  This saves graphic memory, and
  233. gets the screen out of your way when not in use.  The MULTIVIEW gadget
  234. displays the Multi-View window (see below), which allows you to view up
  235. to 108 images at once.  The UP-DOWN gadget toggles the screen between
  236. fully up and just low enough to grab the scroll gadget.  The SHOWIMAGE
  237. gadget loads the current image and moves the screen to the lower
  238. position.
  239.  
  240.     The window title bar will be ghosted when PicBase is not active. 
  241. To activate PicBase, click the left mouse button anywhere inside the
  242. Picbase window.
  243.  
  244. 3    Compiling Data
  245.  
  246.     PicBase must compile data before it presents it to you.  PicBase
  247. has the ability to scan any directory and compile every IFF image in
  248. that directory.  It will also optionally (soon) scan every subdirectory
  249. within a given directory, which allows you to compile a whole disk at
  250. once if desired.
  251.  
  252.     Images are compiled using the LOAD, APPEND and UPDATE commands. 
  253. The only difference between the first two is that LOAD clears the
  254. existing list first.  The difference between the last two are that
  255. APPEND adds every IFF to the list, even if it already exists in the
  256. list, while UPDATE only adds new IFF images to the list (for more
  257. information on UPDATE see below).
  258.  
  259.     After selecting one of these commands, a file requester will
  260. appear.  Below the file requester will appear the ALL gadget.  Clicking
  261. on the ALL gadget will toggle it on or off.  If it is on when you
  262. compile a directory, PicBase will scan all subdirectories within the
  263. directory you choose.  The ALL gadget appears in the state you last
  264. set it to.
  265.  
  266.     Select the directory you want to compile, but leave the filename
  267. gadget blank (PicBase clears the filename gadget for you when selecting
  268. one of these commands).  Click on ACCEPT or OK to compile the
  269. directory.
  270.  
  271.     PicBase will scan through the directory, and will display each IFF
  272. image in turn.  The pointer will change to "PLEASE WAIT" as the image
  273. is loaded, then to "IMAGE SHRINK", and finally to "COLOR REMAP", as
  274. these two functions are performed (invisibly).  Note that on some IFF
  275. images the pointer may not be visible.  The image will then disappear,
  276. and will appear reduced and in grey on the PicBase screen.  The next
  277. image will then be loaded.
  278.  
  279.     To abort a directory scan at any time, hold down the left mouse
  280. button.  You must continue to hold it until the PicBase screen
  281. reappears.
  282.  
  283.     PicBase fills the "timecode" field for each image with
  284. "00:00:00:00".  This field can be modified later for each image.  The
  285. "comment1" field is filled in with the filenote for that image file, or
  286. left blank if there is no filenote (see the AmigaDOS Manual for
  287. information about filenotes).  PicBase also fills in the "comment2"
  288. field with data about the image, including its size, depth and mode
  289. (e.g. HIRES, LACE or HAM).
  290.  
  291.     To continue to compile data from other directories and disks, use
  292. the APPEND command.  You can also load or append individual IFF image
  293. files by specifying the particular filename in the file requester.
  294.  
  295.     Note that if an image or brush is smaller than the PicBase
  296. shrunken images, PicBase will not shrink the image.  If the image is
  297. taller but narrower than the shrunken image, PicBase will only reduce
  298. its height.  This, and the fact that there are different image
  299. resolutions, will change the aspect ratio of some images.  However,
  300. this also yields the largest and thus most easily recognizable images. 
  301.  
  302. 4    Saving Compiled Data
  303.  
  304.     To save a compiled list, use the SAVE command.  A file requester
  305. will appear.  Enter the new filename, and click on OK or ACCEPT.  The
  306. PicBase title bar will display the full pathname of the saved file.
  307.  
  308. 5    Loading Compiled Data
  309.  
  310.     To load a compiled list, use the LOAD command.  A file requester
  311. will appear.  Enter the old filename (or click on the name in the
  312. list), and then click on OK or ACCEPT.  The PicBase title bar will
  313. display the full pathname of the loaded file.
  314.  
  315. 6    Updating Compiled Data
  316.  
  317.     As you continue to add and modify the IFF images on your disks,
  318. your PicBase data file(s) will need to be updated with the new
  319. information.  There are two commands to facilitate this; UPDATE and
  320. CHECK.
  321.  
  322.     UPDATE scans an entire directory for any new images.  New images
  323. are automatically compiled and added to the end of the list.  Also, it
  324. compares the file creation date of each image it finds on the disk with
  325. the image in the compiled list.  If the image on the disk is newer than
  326. the one in the list, the disk image is compiled, and replaces the old
  327. image.
  328.  
  329.     After selecting the UPDATE command, a file requester will appear. 
  330. Below the file requester will appear the ALL gadget.  Clicking on the
  331. ALL gadget will toggle it on or off.  If it is on when you update a
  332. directory, PicBase will scan all subdirectories within the directory
  333. you choose.  The ALL gadget appears in the state you last set it to.
  334.  
  335.     CHECK is used simply to detect if any images in the compiled list
  336. have been deleted from the disk(s).  For each image in the compiled
  337. list, it checks the appropriate disk and directory to see if it exists. 
  338. If it does not, PicBase will ask you if you want to delete the image
  339. from the list.  You can click on YES or NO, and PicBase will go to the
  340. next image in the list.
  341.  
  342.     Note that CHECK will prompt you to insert a disk for each image if
  343. the disk is not already available to PicBase.  If you use floppy
  344. drives, you should sort the list by "PATHNAME" (see sorting below)
  345. before performing CHECK.  Also, if you must delete an image file to
  346. make more room on your disk(s), you may want to keep a record of that
  347. image.
  348.  
  349. 7    Modifying Compiled Data
  350.  
  351.     Some of the data associated with each image can be modified after
  352. it has been compiled.  The following fields can be changed: "timecode",
  353. "comment1" and "comment2".  Make the image to be modified the current
  354. image, then click on the field you want to change.  Type or edit the
  355. changes, then press RETURN to accept the changes.  Click anywhere
  356. outside the field to abort the changes.
  357.  
  358.     The order of the list of images can be modified manually or
  359. automatically.  Manual modification uses the commands CUT, COPY, and
  360. PASTE.  Automatic modification uses the SORT command.
  361.  
  362.     CUT, COPY, and PASTE are used to move and copy individual images. 
  363. CUT and COPY work only on the currently selected image.  In both cases
  364. the current image (and associated data) is moved into the image buffer,
  365. and displayed below and to the right of the current image.  For CUT,
  366. the image is also removed from the list.
  367.  
  368.     PASTE merely inserts the image from the image buffer into the list
  369. just prior to the current image.  Make certain you select the
  370. appropriate current image before you select PASTE.
  371.  
  372.     Note that CUT, COPY, and PASTE only affect the compiled list, and
  373. have no effect on the files on your disk(s).  See below for disk files
  374. modification.
  375.  
  376.     The SORT command automatically rearranges the list according to
  377. criteria you select.  After clicking on SORT, the command gadgets
  378. disappear and five sort gadgets appear.  They are PATH, FILE, DATE,
  379. TICODE, SIZE and CANCEL.  Clicking one of the first five will sort the
  380. list based on the full pathname (useful for keeping images from the
  381. same disk and directory together), the filename (ignoring the path),
  382. the creation date (oldest to youngest), the timecode number or the file
  383. size.  Note that the alphabetical sorts (PATH and FILE) are not case-
  384. sensitive.  CANCEL merely aborts the sort request.
  385.  
  386.     When sorting, a progress report is displayed below the command
  387. gadgets.  You can abort sorting by holding down the left mouse button.
  388.  
  389. 8    Modifying the Disk Files
  390.  
  391.     One the most powerful features of PicBase is its ability to help
  392. you organize your image files on your disk(s).  PicBase allows you to
  393. DELETE, COPY, MOVE and RENAME image files from one disk or directory to
  394. another.  The compiled list is updated automatically after each
  395. operation.
  396.  
  397.     The first three operations work on individual files, or files
  398. saved in the clipboard.  Rename only works on individual files.  If
  399. there are any files in the clipboard, PicBase assumes these are the
  400. files you want to copy, move or delete.
  401.  
  402.     To add an image to the clipboard, simply hold down either SHIFT
  403. key while clicking the left mouse button on the image.  Up to twenty-
  404. two images may be added.  If you hold down the CTRL key while clicking
  405. the left mouse button on an image, the clipboard will fill up with all
  406. subsequent images, up to the maximum.  To clear the clipboard, click on
  407. an image without holding the SHIFT key.
  408.  
  409.     DELETE deletes the current image file (or all clipboard files)
  410. from your disk.  You will prompted if you want to continue with this
  411. operation.  Once an image is deleted from the disk, it is gone forever,
  412. unless you have another copy of it somewhere.
  413.  
  414.     COPY copies the current image file (or clipboard files) from one
  415. disk or directory to another.  After selecting COPY, the file requester
  416. appears, prompting you to enter a new directory (the filename may also
  417. be changed if desired).  Select a new disk or directory, then click on
  418. OK or ACCEPT.  Click on CANCEL to abort.  Note that the new file is not
  419. automatically added to the list; you must do that manually if desired.
  420.  
  421.     Note also that when copying files from the clipboard, you should
  422. leave the FileName in the file requester blank.  Otherwise, the
  423. filename you enter will be prepended onto all copied files (which can
  424. be useful at times).
  425.  
  426.     MOVE moves the current image file (or clipboard files) from one
  427. disk or directory to another.  After selecting MOVE, the file requester
  428. appears, prompting you to enter a new directory.  Select a new disk or
  429. directory, then click on OK or ACCEPT.  Click on CANCEL to abort.  Note
  430. that the compiled list is updated with the new file information.
  431.  
  432.     Note also that when moving files from the clipboard, you should
  433. leave the FileName in the file requester blank.  Otherwise, the
  434. filename you enter will be prepended onto all moved files (which can
  435. be useful at times).
  436.  
  437.     RENAME simply renames the image file.  You will be prompted to
  438. type in a new name.  Press RETURN after entering a new name, or click
  439. anywhere outside of the string gadget to abort the operation.
  440.  
  441. 9    Miscellaneous Commands
  442.  
  443.     SEARCH searches the compiled list for a specific text string,
  444. starting at the image after the current image.  The text search is not
  445. case-sensitive, and currently does not support wildcards.
  446.  
  447.     REVIEW displays every image in the compiled list in sequence,
  448. starting with the current image.  After an image is displayed, the next
  449. image will be displayed after ten seconds.  The next image can be
  450. displayed immediately by briefly clicking the left mouse button.  The
  451. previous image can be displayed by clicking the right mouse button. 
  452. Review is aborted by hitting any key on the keyboard.
  453.  
  454.     REVIEW is double-buffered, and the pointer is invisible, which
  455. makes it ideal for quick slideshow presentations.
  456.  
  457.     PLAY displays the images in sequence as an animation.  Playback
  458. occurs in the "current image" display area.  After selecting PLAY, the
  459. frame rate will be displayed.  Use the left and right arrow keys to
  460. slow down or speed up playback.  The up arrow selects maximum speed
  461. (30 frames per second), the down arrow minimum speed (6 frames per
  462. second).  Click either mouse button to exit the play mode.
  463.  
  464.     PRINT prints a list of IFF images, in the current order.  Two or
  465. three lines of data are printed for each image.  The first line
  466. contains the node number, the full path name, the date created, and the
  467. file size.  The second (optional) line contains the Comment1
  468. information, and the third line contains the Comment2 information.
  469.  
  470.     After selecting PRINT, the file requester appears.  It defaults to
  471. "PRT:", which will send the list to the printer.  If you change the
  472. filename or directory, it will print the information to a file.  You
  473. will be prompted if you attempt to overwrite an existing file.  A page
  474. break and heading is inserted after 58 lines.
  475.  
  476. 10    The Multi-View Window
  477.  
  478.     This window is displayed when the MULTIVIEW gadget is clicked. 
  479. You cannot display the Multi-View window if the list is empty.
  480.  
  481.     Click on an image and it will become highlighted with a flashing
  482. border.  The border will flash only while this window is active. 
  483. Double-click to display any image.
  484.  
  485.     In the upper-right corner are two arrow gadgets, one up and one
  486. down.  Click on the down arrow to display the next page of images (if
  487. there are any).  Click on the up arrow to display the previous page of
  488. images.  Click on the CLOSEWINDOW gadget to exit this mode.
  489.  
  490.  
  491.  
  492. 11    To be continued?...
  493.  
  494.